Skip to content

docs for ask streaming api#2018

Merged
arikalon1 merged 3 commits intomasterfrom
ask-streaming-docs
Mar 1, 2026
Merged

docs for ask streaming api#2018
arikalon1 merged 3 commits intomasterfrom
ask-streaming-docs

Conversation

@arikalon1
Copy link
Contributor

No description provided.

@github-actions
Copy link

github-actions bot commented Feb 26, 2026

Docker image ready for d4f03eb (built in 2m 4s)

⚠️ Warning: does not support ARM (ARM images are built on release only - not on every PR)

Use this tag to pull the image for testing.

📋 Copy commands

⚠️ Temporary images are deleted after 30 days. Copy to a permanent registry before using them:

gcloud auth configure-docker us-central1-docker.pkg.dev
docker pull us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:d4f03eb
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:d4f03eb me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:d4f03eb
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:d4f03eb

Patch Helm values in one line:

helm upgrade --install robusta robusta/robusta \
  --reuse-values \
  --set runner.image=me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:d4f03eb

@coderabbitai
Copy link

coderabbitai bot commented Feb 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ed4867d and aea31a0.

📒 Files selected for processing (1)
  • docs/configuration/holmesgpt/holmes-chat-api.rst
✅ Files skipped from review due to trivial changes (1)
  • docs/configuration/holmesgpt/holmes-chat-api.rst

Walkthrough

Adds comprehensive Streaming (SSE) mode documentation to the Holmes Chat API: how to enable streaming, request/response examples, SSE event types and payload schemas, and client consumption examples for Python and JavaScript.

Changes

Cohort / File(s) Summary
Streaming API Documentation
docs/configuration/holmesgpt/holmes-chat-api.rst
Introduces Streaming (SSE) Mode: how to enable (stream: true), streaming request/response examples in SSE wire format, definitions and payload schemas for SSE events (start_tool_calling, tool_calling_result, ai_message, ai_answer_end, error, token_count, approval_required), and client consumption examples (Python, JavaScript).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive No pull request description was provided by the author, making it impossible to assess whether documentation context and rationale are adequately explained. Consider adding a brief description explaining the purpose of the streaming API documentation and any related context or changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs for ask streaming api' accurately describes the changeset, which adds documentation for streaming API functionality to the Holmes Chat API.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch ask-streaming-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/configuration/holmesgpt/holmes-chat-api.rst`:
- Line 463: The doc currently mixes "terminal event" and "stream pauses" for the
approval_required event—pick one semantic and make the description consistent:
either mark approval_required as a terminal event (meaning the stream ends and a
separate resume/restart message is required) or as a pausing event (meaning the
stream remains open and resumes automatically once approval is granted). Update
the sentence describing approval_required to use the chosen protocol term
consistently and adjust any following text that references resume flow to match
(search for the token approval_required and the phrases "terminal" or "pauses"
to locate the related lines).

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c5ed072 and ed4867d.

📒 Files selected for processing (1)
  • docs/configuration/holmesgpt/holmes-chat-api.rst

RoiGlinik
RoiGlinik previously approved these changes Mar 1, 2026
@arikalon1 arikalon1 merged commit eae833b into master Mar 1, 2026
5 checks passed
@arikalon1 arikalon1 deleted the ask-streaming-docs branch March 1, 2026 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants